Added deleteSQLCLI to be called before the sql-cli is cloned in case … #271

MitchellGale · 2023-05-30T19:42:50Z

Description

cloneSqlCli now depends on new task deleteSQLCLI which deletes doctest/sql-cli before it is used.

When execution of doctests is halted during execution the doctest/sql-cli directory is not deleted.

Steps to reproduce the behavior:
Run OpenSearch SQL Plugin build and stop build during doctest execution.
Run OpenSearch SQL Plugin build again and observe Execution failed for task ':doctest:cloneSqlCli'. error.

What is the expected behavior?
doctest/sql-cli should be deleted before clone is attempted.

Issues Resolved

#1675

Check List

New functionality includes testing.
- All tests pass, including unit test, integration test and doctest
New functionality has been documented.
- New functionality has javadoc added
- New functionality has user manual doc added
Commits are signed per the DCO using --signoff

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

…directory already exists. Signed-off-by: Mitchell Gale <[email protected]>

Yury-Fridlyand · 2023-05-30T19:48:55Z

Maybe don't delete and don't clone, but use pip install?

MitchellGale · 2023-05-30T19:53:16Z

@Yury-Fridlyand, interesting. Would that not cause issues because we are not working in venv or some other virtual environment? Differences in versions, needing to update the version etc might cause issues?

MitchellGale · 2023-05-30T19:54:50Z

The existing code also calls for the directory to be deleted after doctests is finished

task doctest(type: Exec, dependsOn: ['bootstrap']) {

    commandLine "$projectDir/bin/test-docs"

    doLast {
        // remove the cloned sql-cli folder
        file("$projectDir/sql-cli").deleteDir()
        println("Doctest Done")
    }
}

But I wouldn't complain moving everything to a better system.

Yury-Fridlyand · 2023-05-30T20:01:50Z

I think you can run pip install --upgrade opensearchsql. It will do nothing, if CLI tool is already installed.
BTW, here is good place to move doctests to another CI workflow, ref opensearch-project#915.

MitchellGale · 2023-05-30T20:04:13Z

Thank you! I'll switch this to a draft and implement the fix with pip install upgrade.

You're saying I should implement the split in this PR as well? I can certainly add that as well.

codecov · 2023-05-30T20:48:37Z

Codecov Report

❗ No coverage uploaded for pull request base (integ-fix_SQLCLIDocTestDelete@9824b1c). Click here to learn what that means.
The diff coverage is n/a.

@@                       Coverage Diff                        @@
##             integ-fix_SQLCLIDocTestDelete     #271   +/-   ##
================================================================
  Coverage                                 ?   97.23%           
  Complexity                               ?     4270           
================================================================
  Files                                    ?      372           
  Lines                                    ?    10652           
  Branches                                 ?      770           
================================================================
  Hits                                     ?    10358           
  Misses                                   ?      287           
  Partials                                 ?        7

Flag	Coverage Δ
sql-engine	`97.23% <0.00%> (?)`

Flags with carried forward coverage won't be shown. Click here to find out more.

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

MitchellGale · 2023-05-30T21:22:03Z

@Yury-Fridlyand, looks like there might be some issues doing this. It seems to be possible with the commandLine command, but pip commands can be different with different operating systems. We can also call a python script to do the install, but then similar case with python script syntax being different for different OS. A fix would be to do a branch if windows, if not etc. There is a shell script already in doctest/bootstrap.sh which seems to install the sql-cli

$DIR/.venv/bin/pip install -e ./sql-cli

Perhaps this shell script venv install could be used?

Yury-Fridlyand · 2023-05-30T21:59:52Z

Yes, I hope so.
In order to simplify testing, you can create a separate branch and remove all workflows, but doctest. Keep it running on all platforms to ensure that it works fine.

Yury-Fridlyand · 2023-05-31T18:37:24Z

To track: opensearch-project#1281

* Implement creation of ip2geo feature (#257) * Update gradle version to 7.6 (#265) Signed-off-by: Vijayan Balasubramanian <[email protected]> * Implement creation of ip2geo feature * Implementation of ip2geo datasource creation * Implementation of ip2geo processor creation Signed-off-by: Heemin Kim <[email protected]> --------- Signed-off-by: Vijayan Balasubramanian <[email protected]> Signed-off-by: Heemin Kim <[email protected]> Co-authored-by: Vijayan Balasubramanian <[email protected]> * Added unit tests with some refactoring of codes (#271) * Add Unit tests * Set cache true for search query * Remove in memory cache implementation (Two way door decision) * Relying on search cache without custom cache * Renamed datasource state from FAILED to CREATE_FAILED * Renamed class name from *Helper to *Facade * Changed updateIntervalInDays to updateInterval * Changed value type of default update_interval from TimeValue to Long * Read setting value from cluster settings directly Signed-off-by: Heemin Kim <[email protected]> * Sync from main (#280) * Update gradle version to 7.6 (#265) Signed-off-by: Vijayan Balasubramanian <[email protected]> * Exclude lombok generated code from jacoco coverage report (#268) Signed-off-by: Heemin Kim <[email protected]> * Make jacoco report to be generated faster in local (#267) Signed-off-by: Heemin Kim <[email protected]> * Update dependency org.json:json to v20230227 (#273) Co-authored-by: mend-for-github-com[bot] <50673670+mend-for-github-com[bot]@users.noreply.github.com> * Baseline owners and maintainers (#275) Signed-off-by: Vijayan Balasubramanian <[email protected]> --------- Signed-off-by: Vijayan Balasubramanian <[email protected]> Signed-off-by: Heemin Kim <[email protected]> Co-authored-by: Vijayan Balasubramanian <[email protected]> Co-authored-by: mend-for-github-com[bot] <50673670+mend-for-github-com[bot]@users.noreply.github.com> * Add datasource name validation (#281) Signed-off-by: Heemin Kim <[email protected]> * Refactoring of code (#282) 1. Change variable name from datasourceName to name 2. Change variable name from id to name 3. Added helper methods in test code Signed-off-by: Heemin Kim <[email protected]> * Change field name from md5 to sha256 (#285) Signed-off-by: Heemin Kim <[email protected]> * Implement get datasource api (#279) Signed-off-by: Heemin Kim <[email protected]> * Update index option (#284) 1. Make geodata index as hidden 2. Make geodata index as read only allow delete after creation is done 3. Refresh datasource index immediately after update Signed-off-by: Heemin Kim <[email protected]> * Make some fields in manifest file as mandatory (#289) Signed-off-by: Heemin Kim <[email protected]> * Create datasource index explicitly (#283) Signed-off-by: Heemin Kim <[email protected]> * Add wrapper class of job scheduler lock service (#290) Signed-off-by: Heemin Kim <[email protected]> * Remove all unused client attributes (#293) Signed-off-by: Heemin Kim <[email protected]> * Update copyright header (#298) Signed-off-by: Heemin Kim <[email protected]> * Run system index handling code with stashed thread context (#297) Signed-off-by: Heemin Kim <[email protected]> * Reduce lock duration and renew the lock during update (#299) Signed-off-by: Heemin Kim <[email protected]> * Implements delete datasource API (#291) Signed-off-by: Heemin Kim <[email protected]> * Set User-Agent in http request (#300) Signed-off-by: Heemin Kim <[email protected]> * Implement datasource update API (#292) Signed-off-by: Heemin Kim <[email protected]> * Refactoring test code (#302) Make buildGeoJSONFeatureProcessorConfig method to be more general Signed-off-by: Heemin Kim <[email protected]> * Add ip2geo processor integ test for failure case (#303) Signed-off-by: Heemin Kim <[email protected]> * Bug fix and refactoring of code (#305) 1. Bugfix: Ingest metadata can be null if there is no processor created 2. Refactoring: Moved private method to another class for better testing support 3. Refactoring: Set some private static final variable as public so that unit test can use it 4. Refactoring: Changed string value to static variable Signed-off-by: Heemin Kim <[email protected]> * Add integration test for Ip2GeoProcessor (#306) Signed-off-by: Heemin Kim <[email protected]> * Add ConcurrentModificationException (#308) Signed-off-by: Heemin Kim <[email protected]> * Add integration test for UpdateDatasource API (#307) Signed-off-by: Heemin Kim <[email protected]> * Bug fix on lock management and few performance improvements (#310) * Release lock before response back to caller for update/delete API * Release lock in background task for creation API * Change index settings to improve indexing performance Signed-off-by: Heemin Kim <[email protected]> * Change index setting from read_only_allow_delete to write (#311) read_only_allow_delete does not block write to an index. The disk-based shard allocator may add and remove this block automatically. Therefore, use index.blocks.write instead. Signed-off-by: Heemin Kim <[email protected]> * Fix bug in get datasource API and improve memory usage (#313) Signed-off-by: Heemin Kim <[email protected]> * Change package for Strings.hasText (#314) (#317) Signed-off-by: Heemin Kim <[email protected]> * Remove jitter and move index setting from DatasourceFacade to DatasourceExtension (#319) Signed-off-by: Heemin Kim <[email protected]> * Do not index blank value and do not enrich null property (#320) Signed-off-by: Heemin Kim <[email protected]> * Move index setting keys to constants (#321) Signed-off-by: Heemin Kim <[email protected]> * Return null index name for expired data (#322) Return null index name for expired data so that it can be deleted by clean up process. Clean up process exclude current index from deleting. Signed-off-by: Heemin Kim <[email protected]> * Add new fields in datasource (#325) Signed-off-by: Heemin Kim <[email protected]> * Delete index once it is expired (#326) Signed-off-by: Heemin Kim <[email protected]> * Add restoring event listener (#328) In the listener, we trigger a geoip data update Signed-off-by: Heemin Kim <[email protected]> * Reverse forcemerge and refresh order (#331) Otherwise, opensearch does not clear old segment files Signed-off-by: Heemin Kim <[email protected]> * Removed parameter and settings (#332) * Removed first_only parameter * Removed max_concurrency and batch_size setting first_only parameter was added as current geoip processor has it. However, the parameter have no benefit for ip2geo processor as we don't do a sequantial search for array data but use multi search. max_concurrency and batch_size setting is removed as these are only reveal internal implementation and could be a future blocker to improve performance later. Signed-off-by: Heemin Kim <[email protected]> * Add a field in datasource for current index name (#333) Signed-off-by: Heemin Kim <[email protected]> * Delete GeoIP data indices after restoring complete (#334) We don't want to use restored GeoIP data indices. Therefore we delete the indices once restoring process complete. When GeoIP metadata index is restored, we create a new GeoIP data index instead. Signed-off-by: Heemin Kim <[email protected]> * Use bool query for array form of IPs (#335) Signed-off-by: Heemin Kim <[email protected]> * Run update/delete request in a new thread (#337) This is not to block transport thread Signed-off-by: Heemin Kim <[email protected]> * Remove IP2Geo processor validation (#336) Cannot query index to get data to validate IP2Geo processor. Will add validation when we decide to store some of data in cluster state metadata. Signed-off-by: Heemin Kim <[email protected]> * Acquire lock sychronously (#339) By acquiring lock asychronously, the remaining part of the code is being run by transport thread which does not allow blocking code. We want only single update happen in a node using single thread. However, it cannot be acheived if I acquire lock asynchronously and pass the listener. Signed-off-by: Heemin Kim <[email protected]> * Added a cache to store datasource metadata (#338) Signed-off-by: Heemin Kim <[email protected]> * Changed class name and package (#341) Signed-off-by: Heemin Kim <[email protected]> * Refactoring of code (#342) 1. Changed class name from Ip2GeoCache to Ip2GeoCachedDao 2. Moved the Ip2GeoCachedDao from cache to dao package Signed-off-by: Heemin Kim <[email protected]> * Add geo data cache (#340) Signed-off-by: Heemin Kim <[email protected]> * Add cache layer to reduce GeoIp data retrieval latency (opensearch-project#343) Signed-off-by: Heemin Kim <[email protected]> * Use _primary in query preference and few changes (opensearch-project#347) 1. Use _primary preference to get datasource metadata so that it can read the latest data. RefreshPolicy.IMMEDIATE won't refresh replica shards immediately according to #346 2. Update datasource metadata index mapping 3. Move batch size from static value to setting Signed-off-by: Heemin Kim <[email protected]> * Wait until GeoIP data to be replicated to all data nodes (opensearch-project#348) Signed-off-by: Heemin Kim <[email protected]> * Update packages according to a change in OpenSearch core (opensearch-project#354) * Update packages according to a change in OpenSearch core Signed-off-by: Heemin Kim <[email protected]> * Update packages according to a change in OpenSearch core (opensearch-project#353) Signed-off-by: Heemin Kim <[email protected]> --------- Signed-off-by: Heemin Kim <[email protected]> --------- Signed-off-by: Vijayan Balasubramanian <[email protected]> Signed-off-by: Heemin Kim <[email protected]> Co-authored-by: Vijayan Balasubramanian <[email protected]> Co-authored-by: mend-for-github-com[bot] <50673670+mend-for-github-com[bot]@users.noreply.github.com>

Added deleteSQLCLI to be called before the sql-cli is cloned in case …

cc9f6b2

…directory already exists. Signed-off-by: Mitchell Gale <[email protected]>

MitchellGale requested a review from matthewryanwells May 30, 2023 19:42

MitchellGale requested review from MaxKsyunz, Yury-Fridlyand, forestmvey, acarbonetto and GumpacG as code owners May 30, 2023 19:42

MitchellGale marked this pull request as draft May 30, 2023 20:09

Yury-Fridlyand mentioned this pull request May 30, 2023

Allow backtick around fields in sort cmd opensearch-project/sql#1688

Merged

6 tasks

MitchellGale self-assigned this May 31, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added deleteSQLCLI to be called before the sql-cli is cloned in case … #271

Added deleteSQLCLI to be called before the sql-cli is cloned in case … #271

MitchellGale commented May 30, 2023

Yury-Fridlyand commented May 30, 2023

MitchellGale commented May 30, 2023

MitchellGale commented May 30, 2023

Yury-Fridlyand commented May 30, 2023

MitchellGale commented May 30, 2023

codecov bot commented May 30, 2023

MitchellGale commented May 30, 2023

Yury-Fridlyand commented May 30, 2023

Yury-Fridlyand commented May 31, 2023

Added deleteSQLCLI to be called before the sql-cli is cloned in case … #271

Are you sure you want to change the base?

Added deleteSQLCLI to be called before the sql-cli is cloned in case … #271

Conversation

MitchellGale commented May 30, 2023

Description

Issues Resolved

Check List

Yury-Fridlyand commented May 30, 2023

MitchellGale commented May 30, 2023

MitchellGale commented May 30, 2023

Yury-Fridlyand commented May 30, 2023

MitchellGale commented May 30, 2023

codecov bot commented May 30, 2023

Codecov Report

MitchellGale commented May 30, 2023

Yury-Fridlyand commented May 30, 2023

Yury-Fridlyand commented May 31, 2023